curl --request POST \
--url https://api.paysway.dev/payments/verifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"details": {
"country": "<string>",
"currency": "<string>",
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"creditorAccount": {
"id": {
"value": "<string>",
"type": "IBAN"
},
"type": "<string>"
},
"creditor": {
"name": "<string>",
"address": {
"country": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>",
"department": "<string>",
"streetName": "<string>",
"buildingNumber": "<string>",
"buildingName": "<string>",
"floor": "<string>",
"room": "<string>",
"townName": "<string>",
"townLocationName": "<string>",
"districtName": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"countrySubdivision": "<string>"
},
"contactDetails": {
"email": "<string>",
"phone": "<string>"
},
"dateOfBirth": "2023-12-25",
"taxId": "<string>",
"documents": [
{
"value": "<string>",
"type": "<string>"
}
],
"type": "INDIVIDUAL"
},
"intermediaryAgent1": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent2": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent3": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"settlementInformation": {
"settlementSystem": "SCT"
}
},
"metadata": {}
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"state": "PENDING",
"result": {
"accountStatus": "ACTIVE",
"accountHolderName": {
"verifiedName": "<string>",
"matchStatus": "MATCH"
}
},
"failureReason": "INVALID_FIELD",
"metadata": {}
}Initiates verification of the beneficiary account details. The verification is processed asynchronously. Instantly returns an account verification model with PENDING state that can be then fetched using the ID.
curl --request POST \
--url https://api.paysway.dev/payments/verifications \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"details": {
"country": "<string>",
"currency": "<string>",
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"creditorAccount": {
"id": {
"value": "<string>",
"type": "IBAN"
},
"type": "<string>"
},
"creditor": {
"name": "<string>",
"address": {
"country": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"addressLine3": "<string>",
"department": "<string>",
"streetName": "<string>",
"buildingNumber": "<string>",
"buildingName": "<string>",
"floor": "<string>",
"room": "<string>",
"townName": "<string>",
"townLocationName": "<string>",
"districtName": "<string>",
"postBox": "<string>",
"postCode": "<string>",
"countrySubdivision": "<string>"
},
"contactDetails": {
"email": "<string>",
"phone": "<string>"
},
"dateOfBirth": "2023-12-25",
"taxId": "<string>",
"documents": [
{
"value": "<string>",
"type": "<string>"
}
],
"type": "INDIVIDUAL"
},
"intermediaryAgent1": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent2": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"intermediaryAgent3": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"settlementInformation": {
"settlementSystem": "SCT"
}
},
"metadata": {}
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdDate": "2023-11-07T05:31:56Z",
"updatedDate": "2023-11-07T05:31:56Z",
"state": "PENDING",
"result": {
"accountStatus": "ACTIVE",
"accountHolderName": {
"verifiedName": "<string>",
"matchStatus": "MATCH"
}
},
"failureReason": "INVALID_FIELD",
"metadata": {}
}The access token received from the authorization server in the OAuth 2.0 flow.
The idempotency key is a unique value sent with a request to prevent duplicate processing caused by retries.
Show child attributes
ISO 3166-1 alpha-2 code
ISO 4217 alpha code
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 code
INDIVIDUAL, BUSINESS Show child attributes
Encoded cash settlement system
SCT, SCT_INST, SDD_CORE, SDD_B2B, US_FEDWIRE, US_FEDACH, GB_FPS, GB_CHAPS, GB_CCCC, GB_BACS_CR, GB_BACS_DR, CA_ACSS, CA_LYNX, AU_PCS, AU_RITS, AU_BECS, AU_HVCS Account verification request submitted successfully
PENDING, COMPLETED, FAILED Show child attributes
ACTIVE, INACTIVE, CLOSED, NOT_FOUND, FORBIDDEN INVALID_FIELD, UNAVAILABLE_FINANCIAL_INSTITUTION, UNSUPPORTED_FINANCIAL_INSTITUTION, UNEXPECTED_ERROR