customerRegisterEftPayment

Requires a customer (portal or buyer app) session.

Register a buyer EFT transfer against an order or invoice (exactly one of orderId | invoiceId). Creates a PENDING COLLECTION payment — the "Payment under review" overlay. Errors: EFT_AMOUNT_EXCEEDS_OUTSTANDING. screens 9/10.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CustomerRegisterEftPayment($input: CustomerRegisterEftPaymentInput!) {
  customerRegisterEftPayment(input: $input) {
    paymentNumber
    status
    amount
    currency
    paymentId
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CustomerRegisterEftPayment($input: CustomerRegisterEftPaymentInput!) {\n  customerRegisterEftPayment(input: $input) {\n    paymentNumber\n    status\n    amount\n    currency\n    paymentId\n  }\n}",
  "variables": {
    "input": {
      "amount": 0,
      "paymentDate": "2025-01-15T00:00:00Z",
      "referenceNumber": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "amount": 0,
    "paymentDate": "2025-01-15T00:00:00Z",
    "referenceNumber": "string"
  }
}

Response:

{
  "data": {
    "customerRegisterEftPayment": {
      "paymentNumber": "string",
      "status": "string",
      "amount": 0,
      "currency": "string",
      "paymentId": "id"
    }
  }
}

customerRegisterEftPayment(
  input: CustomerRegisterEftPaymentInput!
): CustomerEftPaymentResult!

Arguments

customerRegisterEftPayment.input ● CustomerRegisterEftPaymentInput! non-null input

The details of the customer register eft payment request.

Type

CustomerEftPaymentResult object

A buyer-registered EFT payment: created PENDING (never auto-allocated); the seller verifies. Errors: EFT_AMOUNT_EXCEEDS_OUTSTANDING.