Skip to content
/
Payment

Payment

Request

Execute payment to beneficiary with specified bank details.

Security
bearerAuth
Query
timeoutnumber, [ 10 .. 120 ](Timeout)

How long to wait for the payment to be accepted. When the wait runs out the payment is failed with status reason Submit timeout and is never submitted to a provider.

Default:30
Bodyapplication/jsonrequired
Any of:
external_idExternalIdStr (string) or null
Any of:

Unique ID provided by API user. Alphanumerics and -, _, ., # only.

[ 1 .. 128 ] characters
string(ExternalIdStr)
payment_typestring(Payment Type)required
Value:"B2B"
payment_countrystring(Payment Country)required
Value:"IND"
payment_methodstring(Payment Method)required
Value:"bank_transfer"
payment_detailsobject(PaymentDetailsB2BIndiaBankTransfer)required
currencystring(CurrencyCode)required

Source currency (the currency will be automatically converted to local currency using the provided quote)

Enum:"BHD""EUR""KWD""MYR""OMR""QAR""SAR""SGD""TRY""AED"
amountnumber, > 0(Amount)required

The payout amount, in the destination (local) currency. With a quote, send its amount_destination verbatim; do not recompute it from rate. It must fall inside the quote's limits.min_amount_destination / limits.max_amount_destination band.

senderobject(Sender[B2X, PaymentCountry, PaymentMethod])required

Sender details

beneficiaryobject(Beneficiary[X2B,PaymentCountry,PaymentMethod])required

Beneficiary details

remarksstring or null(Remarks)
Any of:

Supplementary note

non-empty
string
purposePaymentPurpose (string) or null
Any of:

Why the sender is making the payment.

string(PaymentPurpose)
Enum:"family_support""personal_transfer""savings""medical""education""loan_repayment""salary""goods_services""investment""gift"
quotestring or null(Quote)
Any of:

Currency quote id (UUID) as returned by POST /v3/quote; its currency must match currency. The payment is then charged to your wallet. Omit it to pay from the local-currency balance bought through deals instead.

string (uuid)
payment_currencystring or null
Any of:

Destination currency. Informational -- it is fixed by payment_country, and is rejected if it disagrees. Filled in from payment_country when omitted.

string(INR)
curl -i -X POST \
  'https://docs.swiftxpay.com/_mock/openapi/v3/payment?timeout=30' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "string",
    "payment_type": "B2B",
    "payment_country": "IND",
    "payment_method": "bank_transfer",
    "payment_details": {},
    "currency": "BHD",
    "amount": 1,
    "sender": {
      "name": "string",
      "address": "string",
      "country": "str",
      "id": "string"
    },
    "beneficiary": {
      "name": "string",
      "address": "string",
      "country": "str"
    },
    "remarks": "string",
    "purpose": "family_support",
    "quote": "ac2490ad-7b17-416c-8a94-838b251071f6",
    "payment_currency": "INR"
  }'

Responses

Successful Response

Bodyapplication/json
idstring, (uuid)(Id)required

Payment id.

quoteobject(QuoteResponse)required

The quote this payment was made against; for a payment from the local balance, the one priced internally for it.

fundingstring(PaymentFunding)

Which balance pays for it: the wallet (stablecoin) or the local currency bought through deals (local).

Default:"stablecoin"
Enum:"stablecoin""local"
orderPayment[B2B,India,BankTransfer] (object) or Payment[B2C,India,BankTransfer] (object) or Payment[C2B,India,BankTransfer] (object) or Payment[C2C,India] (any) or Payment[C2C,Pakistan,BankTransfer] (object) or Payment[C2C,Nigeria,BankTransfer] (object)(PaymentOrder)required
Any of:

The payment as you submitted it.

responseobject(PaymentResponse)required

Current status and processing result.

accountValidateBeneficiaryResponsePublic (object) or null
Any of:

Beneficiary account validation result, when validation ran.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "quote": {
    "amount_destination": 8488.79,
    "amount_source": 100,
    "country": "IND",
    "currency": "USD",
    "id": "00000000-0000-7000-8000-000000000000",
    "limits": { … },
    "payment_method": "bank_transfer",
    "rate": 84.887912,
    "timestamp": "2024-12-01T01:02:03.000000Z",
    "wallet_info": { … }
  },
  "funding": "stablecoin",
  "order": {
    "external_id": "string",
    "payment_type": "B2B",
    "payment_country": "IND",
    "payment_method": "bank_transfer",
    "payment_details": {},
    "currency": "BHD",
    "amount": 1,
    "sender": { … },
    "beneficiary": { … },
    "remarks": "string",
    "purpose": "family_support",
    "quote": "ac2490ad-7b17-416c-8a94-838b251071f6",
    "payment_currency": "INR"
  },
  "response": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "external_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "status": "queued",
    "msg": "string",
    "quote": "ac2490ad-7b17-416c-8a94-838b251071f6",
    "amount": 0,
    "currency": "BDT",
    "exchange_info": { … },
    "wallet_info": { … },
    "payment_reference": "string",
    "related_info": { … }
  },
  "account": {
    "status": "valid"
  }
}