WSPN

Add Remit Info

Developing

POST

/openapi/v1/remit-info/add

API to add the bank account for withdrawals.

Request

Body Params application/json

requestId

string

required

A unique identifier for the request.
If the same request is sent again with the same requestId, it will be rejected to prevent duplicate processing.

<= 64 characters

beneficiaryName

string

required

<= 255 characters

beneficiaryAddress

string

required

<= 255 characters

beneficiaryBankCountry

string

required

<= 3 characters

beneficiaryBankName

string

required

<= 255 characters

beneficiaryAccount

string

required

<= 255 characters

currency

string

required

bankType

string

required

"SWIFT"

<= 32 characters

beneficiaryBankSwiftCode

string

required

Pattern: [a-zA-Z0-9]

<= 11 characters

beneficiaryBankCity

string

optional

<= 255 characters

beneficiaryBankAddress

string

required

<= 255 characters

isIntermediaryRequired

boolean

required

If the field is true, then the intermediary info is required

intermediaryBankCountry

string

optional

<= 3 characters

intermediaryBankName

string

optional

<= 255 characters

intermediaryBankAccount

string

optional

<= 255 characters

intermediaryBankSwiftCode

string

optional

Pattern: [a-zA-Z0-9]

<= 3 characters

intermediaryBankCity

string

optional

<= 255 characters

intermediaryBankAddress

string

optional

<= 255 characters

Example

Field	Type	Required	Max Length	Description
requestId	String	Y	64	A unique identifier for the request. If the same request is sent again with the same requestId, it will be rejected to prevent duplicate processing.
beneficiaryName	String	Y	255
beneficiaryAddress	String	Y	255
beneficiaryBankCountry	String	Y	3
beneficiaryBankName	String	Y	255
beneficiaryAccount	String	Y	255
currency	String	Y
bankType	String	Y	32	"SWIFT"
beneficiaryBankSwiftCode	String	Y	11	Pattern: [a-zA-Z0-9]
beneficiaryBankCity	String	N	255
beneficiaryBankAddress	String	Y	255
isIntermediaryRequired	Boolean	Y		If the field is true, then the intermediary info is required
intermediaryBankCountry	String	N	3
intermediaryBankName	String	N	255
intermediaryBankAccount	String	N	255
intermediaryBankSwiftCode	String	N	11	Pattern: [a-zA-Z0-9]
intermediaryBankCity	String	N	255
intermediaryBankAddress	String	N	255

{
  "query": {
    "requestId": "af52c151a-4779-4bdd-811fD1-D2d112",
    "currency": "USD",
    "bankType": "SWIFT",
    "beneficiaryName": "John Doe",
    "beneficiaryAccount": "123456789",
    "beneficiaryAddress": "123 Main St",
    "beneficiaryBankName": "Bank of America",
    "beneficiaryBankAddress": "123 Main St",
    "beneficiaryBankCountry": "US",
    "beneficiaryBankSwiftCode": "BFA",
    "beneficiaryBankCity": "New York",
    "isIntermediaryRequired": "true",
    "intermediaryBankName": "Bank of America",
    "intermediaryBankAddress": "123 Main St",
    "intermediaryBankAccount": "123456789",
    "intermediaryBankSwiftCode": "BFA",
    "intermediaryBankCity": "New York",
    "intermediaryBankCountry": "US"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://wallet.test.wspn.io/openapi/v1/remit-info/add' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": {
        "requestId": "af52c151a-4779-4bdd-811fD1-D2d112", 
        "currency": "USD",
        "bankType": "SWIFT",
        "beneficiaryName": "John Doe",
        "beneficiaryAccount": "123456789",
        "beneficiaryAddress": "123 Main St",
        "beneficiaryBankName": "Bank of America",
        "beneficiaryBankAddress": "123 Main St",
        "beneficiaryBankCountry": "US",
        "beneficiaryBankSwiftCode": "BFA",
        "beneficiaryBankCity": "New York",
        "isIntermediaryRequired": "true",
        "intermediaryBankName": "Bank of America",
        "intermediaryBankAddress": "123 Main St",
        "intermediaryBankAccount": "123456789",
        "intermediaryBankSwiftCode": "BFA",
        "intermediaryBankCity": "New York",
        "intermediaryBankCountry": "US"
    }
}'

Responses

🟢200成功

application/json

Body

header

object

required

success

boolean

required

result

object

required

integer

required

Example

{
  "header": {
    "success": true
  },
  "result": {
    "id": 1216
  }
}

Get Deposit Remit Info

Edit Remit Info