Subscribe to collection events

POST 
/api/v1/collections/subscribe

Subscribe to updates across all collections

Request

application/json

Body

required

callbackUrl stringrequired
sharedKey stringrequired
headerKey string
headerValue string

Responses

201

Created

application/json

Schema

Schema

id uuidrequired

Unique identifier of the collection

shortId stringrequired

Short ID of the collection

collectionStatus object

Status of a collection

state stringrequired

Possible values: [PENDING, SUCCESS, FAILED]

The state of a collection

reason string

Possible values: [PENDING, PENDING_AWAITING_DOCUMENT, FAILED, FAILED_DECLINED_NANE_MISSMATCH, FAILED_DECLINED_OTHER, FAILED_TIMED_OUT_NOT_RECEIVED, SUCCESS]

The reason for the state of a collection

complete boolean

Completion status

externalId stringrequired

External identifier for the collection request

sender objectrequired

Information about the sender initiating the collection

companyName stringrequired

Name of the sender's company

accountIdentifier string

Account identifier of the sender, IBAN or local account number

email stringrequired

Email address of the sender

contactNumber stringrequired

Contact number of the sender

receivingWalletId uuidrequired

UUID of the wallet receiving the funds

exchangeQuoteId uuid

UUID of the exchange quote if linking to onward exchange

quoteId uuidrequired

UUID of the collection processing fee

invoices object[]required
List of invoices associated with the collection request
Array [
documentReference stringrequired
Reference for the invoice document
sellerName stringrequired
Name of the seller on the invoice
grossAmount objectrequired
amount numberrequired
The specific monetary value that is being converted from in the currency exchange
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
document object
Receipt file in Base64-encoded format
mediaType stringrequired
The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image
name stringrequired
The name of the file, including the file extension
]
payments object[]
List of payments associated with the collection request
Array [
paymentReference stringrequired
Reference for the payment
paymentAmount objectrequired
amount numberrequired
The specific monetary value that is being converted from in the currency exchange
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
receipt objectrequired
Receipt file in Base64-encoded format
mediaType stringrequired
The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image
name stringrequired
The name of the file, including the file extension
]

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "shortId": "TR123",
  "collectionStatus": {
    "state": "PENDING",
    "reason": "PENDING",
    "complete": false
  },
  "externalId": "string",
  "sender": {
    "companyName": "string",
    "accountIdentifier": "string",
    "email": "string",
    "contactNumber": "string"
  },
  "receivingWalletId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "exchangeQuoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "invoices": [
    {
      "documentReference": "string",
      "sellerName": "string",
      "grossAmount": {
        "amount": 100,
        "currency": "USD"
      },
      "document": {
        "mediaType": "application/pdf",
        "name": "document.pdf"
      }
    }
  ],
  "payments": [
    {
      "paymentReference": "PAY123456789",
      "paymentAmount": {
        "amount": 100,
        "currency": "USD"
      },
      "receipt": {
        "mediaType": "application/pdf",
        "name": "document.pdf"
      }
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

401

Unauthorized

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

403

Forbidden

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

404

Not Found

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

405

Method Not Allowed

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

415

Unsupported Media Type

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

429

Too Many Requests

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

500

Internal Server Error

application/json

Schema

Schema

type uri
title string
status int32
detail string
instance uri
properties object
property name* object

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "properties": {}
}

Callbacks

POST Collection webhook

POST 
$request.body.callbackUrl

application/json

Body

required

Request body to be implemented

id uuidrequired

Unique identifier of the collection

shortId stringrequired

Short ID of the collection

collectionStatus object

Status of a collection

state stringrequired

Possible values: [PENDING, SUCCESS, FAILED]

The state of a collection

reason string

Possible values: [PENDING, PENDING_AWAITING_DOCUMENT, FAILED, FAILED_DECLINED_NANE_MISSMATCH, FAILED_DECLINED_OTHER, FAILED_TIMED_OUT_NOT_RECEIVED, SUCCESS]

The reason for the state of a collection

complete boolean

Completion status

externalId stringrequired

External identifier for the collection request

sender objectrequired

Information about the sender initiating the collection

companyName stringrequired

Name of the sender's company

accountIdentifier string

Account identifier of the sender, IBAN or local account number

email stringrequired

Email address of the sender

contactNumber stringrequired

Contact number of the sender

receivingWalletId uuidrequired

UUID of the wallet receiving the funds

exchangeQuoteId uuid

UUID of the exchange quote if linking to onward exchange

quoteId uuidrequired

UUID of the collection processing fee

invoices object[]required
List of invoices associated with the collection request
Array [
documentReference stringrequired
Reference for the invoice document
sellerName stringrequired
Name of the seller on the invoice
grossAmount objectrequired
amount numberrequired
The specific monetary value that is being converted from in the currency exchange
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
document object
Receipt file in Base64-encoded format
mediaType stringrequired
The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image
name stringrequired
The name of the file, including the file extension
base64EncodedFile stringrequired
The content of the file, encoded as a Base64 string
]
payments object[]
List of payments associated with the collection request
Array [
paymentReference stringrequired
Reference for the payment
paymentAmount objectrequired
amount numberrequired
The specific monetary value that is being converted from in the currency exchange
currency stringrequired
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
receipt objectrequired
Receipt file in Base64-encoded format
mediaType stringrequired
The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image
name stringrequired
The name of the file, including the file extension
base64EncodedFile stringrequired
The content of the file, encoded as a Base64 string
]

Callbacks Responses

200

None 200 will be retried with exponential backoff upto 7 days

Loading...