v1

latestOpenAPI 3.1.02026-07-26460218.4 KB

Accept Collection Request

Accept a collection request for execution.

post/receive/{id}/accept

Path parameters

idstring required

Unique Receive Identifier

Request body

{"stackTrail":"paths:/receive/{id}/accept:post:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

partnerIdstring

currencystring

ratenumber

statusstring

createdAtstring

sequenceIdstring

countrystring

referencestring

convertedAmountnumber

channelIdstring

expiresAtstring

updatedAtstring

amountinteger

idstring

depositIdstring

Example response

{
  "partnerId": "9ecf5248-17e7-4a2b-b5a8-3bd58ff0fe01",
  "currency": "NGN",
  "rate": 487.89,
  "bankInfo": {
    "name": "PAGA",
    "accountNumber": "01234567890",
    "accountName": "Ken Adams"
  },
  "status": "processing",
  "createdAt": "2023-02-06T13:31:20.108Z",
  "source": {
    "accountNumber": "1111111111",
    "networkId": "6df48502-1ebe-473f-be17-e2cae4dd67ee",
    "accountType": "bank"
  },
  "sequenceId": "11f4c7f2-f7bb-450c-4s6d-1bd70766d26d",
  "country": "NG",
  "reference": "JJ8094861",
  "convertedAmount": 9757.8,
  "recipient": {
    "country": "Nigeria",
    "address": "Home Address",
    "idType": "license",
    "phone": "+2349092916898",
    "dob": "02/01/1997",
    "name": "John Doe",
    "idNumber": "314159",
    "email": "john.doe@yellowcard.io"
  },
  "channelId": "fe8f4989-3bf6-41ca-9621-ffe2bc127569",
  "expiresAt": "2023-02-06T13:41:20.108Z",
  "updatedAt": "2023-02-06T13:31:48.802Z",
  "amount": 20,
  "id": "805b2317-0da9-42b9-89fb-e14e3fe12dd8",
  "depositId": "47069e2d-b225-4155-9028-2607fe3346bb"
}