PaymentMethod End-point Overview #
URL:
https://crm-api-test.10npay.com/api/v1/IndividualPaymentMethod/{individualId}/iban
Method: POST
Description: This endpoint allows you to create an IBAN payment method for a specific user. Upon successful submission, the payment method will be created with the status set to “in review”.
Headers
accept: */*
Authorization: Bearer {your_auth_token}
Content-Type: application/json-patch+json
Path Parameters:
individualId (integer): The ID of the user for whom the IBAN payment method is being created. Example: 132
Request: #
{
"accountName": "string",
"bankName": "string",
"bankStatement": "string",
"bankStatementFileName": "string",
"ibanNumber": "string",
"swift": "string",
"currency": "string",
"status": "string"
}
accountName (string): The name of the account.
bankName (string): The name of the bank.
bankStatement (string): The bank statement content.
bankStatementFileName (string): The file name of the bank statement.
ibanNumber (string): The IBAN number.
swift (string): The SWIFT code.
currency (string): The currency (must be three uppercase letters).
status (string): The status of the payment method.
cURL Example:
curl -X 'POST' \
'https://app-api-test.10npay.com/api/v1/PaymentMethod/132/iban' \
-H 'accept: */*' \
-H 'Authorization: Bearer {Token}' \
-H 'Content-Type: application/json-patch+json' \
-d '{
"accountName": "string",
"bankName": "string",
"bankStatement": "string",
"bankStatementFileName": "string",
"ibanNumber": "string",
"swift": "string",
"currency": "string",
"status": "string"
}'
Responses #
200 – Success #
Description: The IBAN payment method has been successfully created and is now in review status.
Example:
{}
400 – Bad Request #
Description: The request is invalid. This can happen due to invalid input data.
Examples:
{
"errors": {
"Error": [
"'SWIFT Code' is not valid.",
"'status' is not valid.",
"'Currency' must be three uppercase letter.",
"'IBAN Number' is not valid.",
"'Bank Statement' is not valid."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"traceId": "00-45845b5dfa91f562e818e7b271684724-ba038a6f4150afc1-01"
}
{
"errors": {
"Error": [
"'Bank Statement' must not be empty.",
"'Bank Statement File Name' must not be empty."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "Bad Request",
"status": 400,
"traceId": "00-ff1835be395b350376bdb711949dc093-74f9793031a47573-01"
}
500 – Server Error #
Description: An error occurred on the server side.
Example:
{
"title": "Internal Server Error",
"status": 500,
"traceId": "00-45af4b5c-fd63-4d9f-ae4e-5b6c9a5d14e0-01"
}