Sign in

v1

latestOpenAPI 3.0.02026-07-268955283.0 KB

Get payment by ID

get/payments/{paymentId}

Path parameters

paymentIdstring required

A unique identifier for the payment

Response

Response

idstring

A unique identifier for the payment

userIdstring

A unique identifier for the user

isBusinessboolean

If true this payment will be only of business type

languagestring

The language to use in the consent journey, if not set the user will be able to choose the language

providerIdstring

A unique identifier for the provider

providerIdsstring[]
merchantIdstring

A unique identifier for the merchant

orgIdstring

A unique identifier for the organization

psuIdstring

The national id or passport number of the person who is paying

psuIdTypestring
psuCorporateIdstring

The corporate id of the debtor

psuCorporateIdTypestring
service'masav' | 'fp' | 'zahav'

The type of the payment service

productstring
amountnumber

The amount of the payment

currencystring

The currency of the payment

status'ACCC' | 'ACSC' | 'ACSP' | 'ACTC' | 'ACWC' | 'RCVD' | 'RJCT' | 'CANC' | 'ACFC' | 'PATC' | 'PART' | 'PENDING' | 'ERROR' | 'INIT'

The status of the payment

creditorAccountType'bban' | 'iban'

The type of the acount number of the creditor

creditorAccountNumberstring

The account number of the creditor

debtorAccountType'bban' | 'iban'

The type of the acount number of the debtor

debtorAccountNumberstring

The account number of the debtor

creditorNamestring

The name of the creditor

descriptionstring

The description of the payment

isFakeboolean

Indicates whether the payment is connected to a sandbox provider

authorizationMessagestring
scaStatusstring
psuMessagestring
directPayOnlyboolean

Indicates whether the payment is a direct payment without an open banking consent

isIframeboolean

Indicates whether the payment journey will be displayed inside an iframe

allowBusinessboolean

Indicates whether the payment allows business accounts

redirectUrlstring

The URL to which the user will be redirected after the payment is completed

providerIdentifierstring

A unique identifier for the provider

createdAtstring date-time

The timestamp in UTC when the payment was created

updatedAtstring date-time

The timestamp in UTC when the payment was updated

startDatestring date

The first applicable day of execution for periodic payments

endDatestring date

The last applicable day of execution for periodic payments (optional)

frequency'Daily' | 'Weekly' | 'EveryTwoWeeks' | 'Monthly' | 'EveryTwoMonths' | 'Quarterly' | 'SemiAnnual' | 'Annual' | 'MonthlyVariable'

The frequency of recurring payments

executionRule'following' | 'preceding'

Execution rule for periodic payments when payment date falls on weekend/holiday

dayOfExecutionstring

Day of month for execution (1-31) for periodic payments

monthsOfExecutionstring[]

Array of months (1-12) for execution. Only valid when frequency is 'MonthlyVariable'

batchBookingPreferredboolean

If true, the PSU prefers only one booking entry for bulk payments

paymentInformationIdstring

Identification assigned by the merchant for the bulk payment

requestedExecutionDatestring date

Requested execution date for the payment

requestedExecutionTimestring date-time

Requested execution time for the payment

requestStatus'PENDING' | 'RCVD' | 'ACCP' | 'ACWC' | 'RJCT'

RTP request status (only present for request-to-pay payments)

requestReasonCodestring

Reason code for RTP rejection (only present for request-to-pay payments)

requestAcceptedAmountnumber

Accepted amount if different from requested (only present for request-to-pay payments)

requestDebtorDecisionDateTimestring date-time

Date/time when the debtor made a decision (only present for request-to-pay payments)

requestExpiryDateTimestring date-time

RTP expiry date/time (only present for request-to-pay payments)