Invoice Uploads

Get invoice URL for payment request

get

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

idstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

urlstring · uriRequired

expiresInSecondsnumberRequired

filenamestringRequired

mimeTypestringRequired

404

Default Response

application/json

500

Default Response

application/json

get

/api/v1/{id}/invoice/url

HTTPcURLJavaScriptPython

GET /api/v1/{id}/invoice/url HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "url": "https://example.com",
  "expiresInSeconds": 1,
  "filename": "text",
  "mimeType": "text"
}

Attach invoice to existing payment request

post

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

idstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

uploadIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

messagestringRequired

404

Default Response

application/json

500

Default Response

application/json

post

/api/v1/{id}/invoice/attach/{uploadId}

HTTPcURLJavaScriptPython

POST /api/v1/{id}/invoice/attach/{uploadId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "text"
}

Generate presigned URL for file upload

post

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Body

application/json

filenamestring · min: 1 · max: 255Required

mimeTypestring · min: 1 · max: 100Required

sizenumber · max: 104857600Required

Responses

200

Default Response

application/json

uploadIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

methodstring · enumRequiredPossible values:

urlstring · uriRequired

expiresInSecondsnumberRequired

maxSizenumberRequired

allowedTypesstring[]Required

s3KeystringRequired

400

Default Response

application/json

500

Default Response

application/json

post

/api/v1/invoice-uploads/presign

HTTPcURLJavaScriptPython

POST /api/v1/invoice-uploads/presign HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "filename": "text",
  "mimeType": "text",
  "size": 1
}

{
  "uploadId": "123e4567-e89b-12d3-a456-426614174000",
  "method": "PUT",
  "url": "https://example.com",
  "headers": {
    "Content-Type": "text"
  },
  "expiresInSeconds": 1,
  "maxSize": 1,
  "allowedTypes": [
    "text"
  ],
  "s3Key": "text"
}

Confirm upload completion

post

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

uploadIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

sha256string · min: 64 · max: 64Required

Responses

200

Default Response

application/json

messagestringRequired

404

Default Response

application/json

500

Default Response

application/json

post

/api/v1/invoice-uploads/{uploadId}/confirm

HTTPcURLJavaScriptPython

POST /api/v1/invoice-uploads/{uploadId}/confirm HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "sha256": "text"
}

{
  "message": "text"
}

Generate preview URL for uploaded file

get

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

uploadIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

urlstring · uriRequired

expiresInSecondsnumberRequired

filenamestringRequired

mimeTypestringRequired

404

Default Response

application/json

500

Default Response

application/json

get

/api/v1/invoice-uploads/{uploadId}/preview-url

HTTPcURLJavaScriptPython

GET /api/v1/invoice-uploads/{uploadId}/preview-url HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "url": "https://example.com",
  "expiresInSeconds": 1,
  "filename": "text",
  "mimeType": "text"
}

Attach invoice to payment request

post

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

uploadIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

paymentRequestIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

messagestringRequired

404

Default Response

application/json

500

Default Response

application/json

post

/api/v1/invoice-uploads/{uploadId}/attach/{paymentRequestId}

HTTPcURLJavaScriptPython

POST /api/v1/invoice-uploads/{uploadId}/attach/{paymentRequestId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "text"
}

Delete temporary upload

delete

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Path parameters

uploadIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

204

Default Response

application/json

404

Default Response

application/json

500

Default Response

application/json

delete

/api/v1/invoice-uploads/{uploadId}

HTTPcURLJavaScriptPython

DELETE /api/v1/invoice-uploads/{uploadId} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content