Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
Response
200 - application/json
Enrichments result returned successfully
curl --request POST \
--url https://api.paysway.dev/payments/enrichments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"country": "<string>",
"currency": "<string>",
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"creditorAccount": {
"id": {
"value": "<string>",
"type": "IBAN"
},
"type": "<string>"
},
"creditor": {
"name": "<string>",
"address": {
"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>",
"country": "<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"
}
}'{
"enrichments": {
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"name": "<string>",
"address": {
"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>",
"country": "<string>"
},
"logo": "<string>"
},
"creditorAccount": {
"ids": [
{
"value": "<string>",
"type": "IBAN"
}
]
},
"intermediaryAgent1": {
"bic": "<string>"
},
"intermediaryAgent2": {
"bic": "<string>"
},
"intermediaryAgent3": {
"bic": "<string>"
},
"settlementInformation": {
"settlementSystems": [
"SCT"
]
}
}
}Transforms and completes the fields of the payment instruction to ensure payment success and enhance user experience. It converts account numbers and bank details into formats acceptable for the selected payment method, provides routing inputs such as intermediary banks and supported payment schemes, and returns details such as bank name, address, and logo.
curl --request POST \
--url https://api.paysway.dev/payments/enrichments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"country": "<string>",
"currency": "<string>",
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"branchId": "<string>"
},
"creditorAccount": {
"id": {
"value": "<string>",
"type": "IBAN"
},
"type": "<string>"
},
"creditor": {
"name": "<string>",
"address": {
"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>",
"country": "<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"
}
}'{
"enrichments": {
"creditorAgent": {
"bic": "<string>",
"clearingSystemMemberId": {
"memberId": "<string>"
},
"name": "<string>",
"address": {
"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>",
"country": "<string>"
},
"logo": "<string>"
},
"creditorAccount": {
"ids": [
{
"value": "<string>",
"type": "IBAN"
}
]
},
"intermediaryAgent1": {
"bic": "<string>"
},
"intermediaryAgent2": {
"bic": "<string>"
},
"intermediaryAgent3": {
"bic": "<string>"
},
"settlementInformation": {
"settlementSystems": [
"SCT"
]
}
}
}The access token received from the authorization server in the OAuth 2.0 flow.
ISO 3166-1 alpha-2 code
ISO 4217 alpha code
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enrichments result returned successfully
Show child attributes