Payment

  • amount
    Type: string Pattern: ^\d+\.\d{2}$
    required

    Payment amount as a decimal string with two decimal places

  • createdAt
    Type: stringFormat: date-time
    required

    Timestamp when the payment was created

  • currency
    Type: string
    required

    Three-letter ISO 4217 currency code

  • customerId
    Type: string
    required

    Your internal customer identifier

  • id
    Type: stringFormat: uuid
    required

    Unique identifier for the payment

  • merchantId
    Type: stringFormat: uuid
    required

    Your merchant account identifier

  • merchantReference
    Type: string
    required

    Your unique order or transaction reference

  • paymentIntentId
    Type: stringFormat: uuid
    required

    Identifier of the payment intent that initiated this payment

  • paymentMethodId
    Type: string
    required

    Payment method identifier used for this payment

  • providerReference
    Type: string
    required

    Reference assigned by the payment provider

  • status
    Type: stringenum
    required

    Current status of the payment:

    • pending - payment created but provider has not confirmed yet
    • processing - provider is processing the payment
    • succeeded - funds captured successfully
    • held - funds are held by the provider pending review
    • failed - payment was rejected or could not be captured
    values
    • pending
    • processing
    • succeeded
    • held
    • failed