REredcard
MemberPayments

Request payment cancellation

A payment can only be canceled before we have transfered the funds to the provider. You can request a payment cancellation at any time, but if we have already paid the provider this call will return an error with status code 409 (conflict).

post/api/v1/member/{memberId}/payments/{paymentId}/cancel

Request

Path parameters

memberIdstring uuid required

Unique identifier for the member

paymentIdstring uuid required

Unique identifier for the payment

Response

Payment Canceled

Idstring uuid

Unique Payment ID

ConfirmationNumberstring

Payment Confirmation Number

AmountPaidnumber double

Payment Amount

ErrorMessagestring

Error Message

Statusstring

Payment Status PendingProcessing ProcessingPayment AdditionalInfoRequired DrawdownFailure Paid Canceled

SubmittedDatestring date-time

Payment Submitted Date

BillIdstring uuid

Unique identifier for the bill the payment relates to

FundingMethodstring

Payment funding method Stripe (card, native wallet) BankAccount

Example response

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "BillId": "00000000-0000-0000-0000-000000000000"
}

Changes

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