Skip to main content

session/start/payout

session/start/payout​

Send this request to start a payout within an existing session. In the parameters, pass the data necessary to perform a payout or change any pieces of data already passed.

Endpoint​

api/v1/session/start/payout

Request parameters​

NameMandatoryTypeDescription
session_id+stringPayment session identifier
payment_method-objectPayout data
amount_details-objectAmount. Transmitted in the USD decimal format. If you are sending 100 USD, you will need to specify 10000
participant_details-objectInformation on the sender and recipient
customer-objectRecipient's data in your system
metadata-*Additional information. Any data you need in order to perform the operation. Returned in responses and webhooks

If you did not specify payment_method and amount_details in your session/create request, make sure you specify them in this request, since in this case they are mandatory.

Request example
curl -X POST \
  https://demo.smart-glocal.com/api/v1/session/start/payout \
  -H 'content-type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: signature' \
  -d '{
    "session_id": "ps_3230",
    "payment_method": {
      "type": "bank_account",
      "bank_account": {
        "system_type": "global",
        "global": {
          "iban": "NUMBER_VALUE",
          "description": "purpose of remittance"
        }
      }
    },
    "amount_details": {
      "amount": 1000,
      "currency": "usd"
    },
    "participant_details": {
      "recipient": {
        "bank_name": "All Banks Belgium / EUR / Payment System: SEPA",
        "currency": "eur",
        "country_iso3": "BEL",
        "first_name": "John",
        "last_name": "Johnson"
        },
      "sender": {
        "company_name": "Company name",
        "registration_number": "1234567890",
        "country_iso3": "USA",
        "code": "1234567890"
      }
    }
  }'

Response parameters​

NameMandatoryTypeDescription
status+stringStatus. Options: error, ok
session-objectPayment session
error-objectError description
Successful response example
{
  "status": "ok",
  "session": {
    "id": "ps_3230",
    "status": "in_progress",
    "created_at": "2024-05-27T02:03:00.000000Z",
    "updated_at": "2024-05-27T02:03:00.000000Z",
    "payments": [{
        "id": "po_1313",
        "status": "in_progress",
        "created_at": "2024-05-27T02:03:00.000000Z",
        "customer": {
          "reference": "user123",
          "contacts": [{
            "email": "user@gmail.com"
          }]
        },
        "payment_method": {
          "type": "bank_account",
          "bank_account": {
            "system_type": "global",
            "global": {
              "iban": "NUMBER_VALUE",
              "description": "purpose of remittance"
          }
        },
        "amount_details": {
          "amount": 10000,
          "currency": "usd"
        },
        "participant_details": {
          "recipient": {
            "bank_name": "All Banks Belgium / EUR / Payment System: SEPA",
            "currency": "eur",
            "country_iso3": "BEL",
            "first_name": "John",
            "last_name": "Johnson"
          },
          "sender": {
            "company_name": "Company name",
            "registration_number": "1234567890",
            "country_iso3": "USA",
            "code": "1234567890"
          }
        },
        "metadata": "good"
        }
    }]
  }
}
Unsuccessful response example
{
  "error": {
    "code": "error code",
    "description": "error description"
  },
  "status": "error"
}