Direct Debit

Direct Debit

Standard direct-debit payment, its inbound notification, and status/cancel/refund.

resp, err := transferdebit.DirectDebitPayment(ctx, transport, hb, transferdebit.DirectDebitPaymentRequest{
	PartnerReferenceNo: "2020102900000000000001",
})
if err != nil {
	// errors.Is(err, snap.ErrBadRequest), snap.ErrUnauthorized, etc.
}

DirectDebitPayment

DirectDebitPayment calls the SNAP Direct Debit Payment endpoint (Service Code 54, HTTP POST). Pass hb with everything except Body already set — DirectDebitPayment marshals the request itself and uses those exact bytes for both signing and the wire body.

This operation is not idempotent and this package does not retry. Callers that retry a failed or timed-out call should reuse the same X-EXTERNAL-ID, since the server’s own duplicate-detection keys on it.

func DirectDebitPayment(ctx context.Context, t *snap.Transport, hb snap.HeaderBuilder, req DirectDebitPaymentRequest) (DirectDebitPaymentResponse, error)

Request — DirectDebitPaymentRequest

DirectDebitPaymentRequest is the request body for Direct Debit Payment. partnerReferenceNo is the only Mandatory field.

Response — DirectDebitPaymentResponse

DirectDebitPaymentResponse is the response body for Direct Debit Payment. referenceNo is Conditional — present only on success.

Direct Debit Payment Notification

Received — DirectDebitPaymentNotificationRequest

DirectDebitPaymentNotificationRequest is the request body for Direct Debit Payment Notification (Service Code 56) — a settlement callback the PJP receives, not a call this package makes. Wire your own HTTP handler for this path, authenticate the inbound call with ServerVerifier.VerifyTransactionRequest, then json.Unmarshal the body into this type.

originalReferenceNo and latestTransactionStatus are Mandatory; every other field is Optional.

Your handler replies with — DirectDebitPaymentNotificationResponse

DirectDebitPaymentNotificationResponse has one field beyond the envelope, approvalCode, and it’s Optional.

DirectDebitPaymentStatus

DirectDebitPaymentStatus calls the SNAP Direct Debit Payment Status endpoint (Service Code 55, HTTP POST) to check a previous payment’s status. Pass hb with everything except Body already set — DirectDebitPaymentStatus marshals the request itself. This is a read-only lookup, safe to retry freely.

func DirectDebitPaymentStatus(ctx context.Context, t *snap.Transport, hb snap.HeaderBuilder, req DirectDebitPaymentStatusRequest) (DirectDebitPaymentStatusResponse, error)

Request — DirectDebitPaymentStatusRequest

DirectDebitPaymentStatusRequest is the request body for Direct Debit Payment Status. serviceCode is the only Mandatory field — pair it with whichever reference you have.

Response — DirectDebitPaymentStatusResponse

DirectDebitPaymentStatusResponse is the response body for Direct Debit Payment Status. latestTransactionStatus is the only Mandatory field beyond the envelope.

DirectDebitPaymentCancel

DirectDebitPaymentCancel calls the SNAP Direct Debit Payment Cancel endpoint (Service Code 57, HTTP POST). Pass hb with everything except Body already set — DirectDebitPaymentCancel marshals the request itself.

This operation is not idempotent and this package does not retry. Callers that retry a failed or timed-out call should reuse the same X-EXTERNAL-ID, since the server’s own duplicate-detection keys on it.

func DirectDebitPaymentCancel(ctx context.Context, t *snap.Transport, hb snap.HeaderBuilder, req DirectDebitPaymentCancelRequest) (DirectDebitPaymentCancelResponse, error)

Request — DirectDebitPaymentCancelRequest

DirectDebitPaymentCancelRequest is the request body for Direct Debit Payment Cancel. originalPartnerReferenceNo is the only Mandatory field.

Response — DirectDebitPaymentCancelResponse

DirectDebitPaymentCancelResponse is the response body for Direct Debit Payment Cancel. originalReferenceNo and cancelTime are Conditional — present only on success.

DirectDebitPaymentRefund

DirectDebitPaymentRefund calls the SNAP Direct Debit Payment Refund endpoint (Service Code 58, HTTP POST). Pass hb with everything except Body already set — DirectDebitPaymentRefund marshals the request itself.

This operation is not idempotent and this package does not retry. Callers that retry a failed or timed-out call should reuse the same X-EXTERNAL-ID, since the server’s own duplicate-detection keys on it.

func DirectDebitPaymentRefund(ctx context.Context, t *snap.Transport, hb snap.HeaderBuilder, req DirectDebitPaymentRefundRequest) (DirectDebitPaymentRefundResponse, error)

Request — DirectDebitPaymentRefundRequest

DirectDebitPaymentRefundRequest is the request body for Direct Debit Payment Refund. originalPartnerReferenceNo and partnerRefundNo are Mandatory.

Response — DirectDebitPaymentRefundResponse

DirectDebitPaymentRefundResponse is the response body for Direct Debit Payment Refund. originalReferenceNo is Conditional — present only on success. refundNo, partnerRefundNo, and refundTime are Mandatory.