Payments

Initiate a single payment

Use this method to initiate a single Payment.

post/v2/single-payment

Request

Base URL
https://api.sandbox.payall.com
Auth
OAuth 2
Client credentials
Token URL: /v2/oauth/token

Request body

Field	recipient_id	recipient	payment_instrument	payment_instrument_id
recipient_id		✗	✓	✗
recipient	✗		✓	✗
payment_instrument	✓	✓		✗
payment_instrument_id	✗	✗	✗

Field	recipient_id	recipient	payment_instrument	payment_instrument_id
recipient_id		✗	✓	✗
recipient	✗		✓	✗
payment_instrument	✓	✓		✗
payment_instrument_id	✗	✗	✗

Example request

{
  "end_to_end_id": "PA-ecf87cf814cd4d95a970ac7e8d7e7ef3",
  "payer": {
    "accounts": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "owner_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "owner_name": "John Doe vs Trade Company",
        "created": "2023-10-27T08:57:09.374902",
        "number": "CC802200MONEPA00001239806444EUR",
        "name": "Digital Account",
        "currency": "EUR",
        "balance": {
          "currency": "EUR",
          "value": 10023
        }
      }
    ],
    "employer_country": "PL"
  },
  "recipient": {
    "country": "PL"
  },
  "payment_instrument": {
    "masked_number": "1234 **** **** 3456"
  },
  "operation": {
    "source_amount": {
      "currency": "EUR",
      "value": 10023
    },
    "target_currency": "PLN"
  },
  "kyt": {
    "destination_country": "GB"
  }
}

Response

Created

Returns new payment details.

end_to_end_idstring

End To End Identification This filed follows ISO 20022 guidelines.

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction.

If not provided, a random UUID based identifier will be generated.

client_payment_idstring required

External reference provided when initiating the payment.

transaction_idstring

External reference provided when initiating the payment. (Same as client_payment_id)

instruction_idstring

Id of the instruction registered in Payall system.

uetrstring uuid

Universally unique identifier to provide an end-to-end reference of a payment transaction.

integration_idstring

Identifier used in communication with the Clearing Institution.

idstring uuid required

Id of the newly initiated payment.

initiated_atstring date-time required

The date-time when the payment was initiated. Notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

updated_atstring date-time required

The date-time when the payment was updated last time. Notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z.

statusstring required

recipient_idstring uuid

Id of the recipient used for this payment.

If recipient_id was provided for the PaymentRequest then its value is returned unchanged. If new recipient information was provided then this field will contain the ID under which the new recipient information has been stored.

payment_instrument_idstring uuid

Id of the payment instrument used for this payment.

If payment_instrument_id was provided for the PaymentRequest then its value is returned unchanged. If new payment instrument information was provided then this field will contain the ID under which the new payment instrument has been stored.

codestring

Decline or error code as received from the payment provider or Payall. Only present when the payment was declined.

decline_issuerstring

Entity that issued the decline: PAYALL for internal failures, the service provider name for external failures.

auto_confirmedboolean

Whether the payment was confirmed automatically right after creation.

true if the caller holds the auto-confirm scope. false if the payment was instead parked at PendingConfirmation, awaiting an explicit confirm call.

Example response

{
  "end_to_end_id": "PA-ecf87cf814cd4d95a970ac7e8d7e7ef3",
  "uetr": "bb1ccd4b-5072-4731-944f-45425c2b9e97",
  "fees": {
    "payer": {
      "currency": "EUR",
      "value": 10023
    },
    "recipient": {
      "currency": "EUR",
      "value": 10023
    }
  },
  "exchange_rate": {
    "source_amount": {
      "currency": "EUR",
      "value": 10023
    },
    "target_amount": {
      "currency": "EUR",
      "value": 10023
    }
  },
  "error": {
    "code": "00005",
    "message": "Only recipient_id or recipient values are allowed but not both."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.