Update Payment

Update a payment. This endpoint can be used to update a PT_ACCTOUNTDISB payment

Request
Security:
Bearer
path Parameters
payment_guid
required
string <uuid>
version
required
string
Request Body schema: application/json
object (UpdatePaymentPayer)

Payer: Identifies the original source of funds. If both the account guid and an outside instrument guid are provided, funds will be pulled from outside instrument to the payer's account guid before being sent to the payee. However, the outside instrument guid must belong to the payer.

object (UpdatePaymentPayee)

Payee: Identifies the ultimate recipient of funds. If both the account guid and an outside instrument guid are provided, funds will be deposited to the outside instrument from the payee's account guid after it is received from the payer. However, the outside instrument guid must belong to the payee.

status
string (StatusPaymentOption)

Desired Payment Status

Value: "CANCEL"
object (AdditionalData)
Responses
200

Returns updated payment

400

Bad request

401

Unauthorized

404

Program not found

500

Server Error

post/api/{version}/payments/{payment_guid}/update
Request samples
application/json
{
  • "payer": {
    • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "card_proxy": "string",
    • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
    • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
    • "preferred_transfer_type": "string",
    • "account_type": "string",
    • "instrument_type": "string"
    },
  • "payee": {
    • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
    • "payment_due": 0,
    • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
    • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
    • "reference_code": "string",
    • "preferred_transfer_type": "string",
    • "card_proxy": "string",
    • "quote_reference": "string",
    • "foreign_exchange_purpose_code": "EFT_TRF_SELF",
    • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
    • "account_type": "48eed880-2e7e-464c-98b0-b2fc5c579e74",
    • "instrument_type": "e5ecf7da-d772-40c4-aa8f-f77f195db348"
    },
  • "status": "CANCEL",
  • "additional_data": {
    • "check_info": {
      • "template_alias": "string",
      • "payee_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "ship_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "shipping_method": "string",
      • "bulk_shipment_flag": true,
      • "return_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "remittance_section_1": {
        • "remittance_s1_line1": "string",
        • "remittance_s1_line2": "string",
        • "remittance_s1_line3": "string",
        • "remittance_s1_line4": "string",
        • "remittance_s1_line5": "string",
        • "remittance_s1_line6": "string"
        },
      • "remittance_section_2": {
        • "remittance_s2_line1": "string",
        • "remittance_s2_line2": "string",
        • "remittance_s2_line3": "string"
        },
      • "check_stub_footer_text": "string",
      • "payer_detail": {
        • "payer_logo_file_name": "string",
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "check_void_after_days": 1,
      • "check_memo_line": "string",
      • "check_footer_text": "string",
      • "print_authorized_signatory1": true,
      • "print_authorized_signatory2": true,
      • "additional_detail": {
        • "check_stub_label1": "string",
        • "check_stub_label1_value": "string",
        • "check_stub_label2": "string",
        • "check_stub_label2_value": "string",
        • "check_label": "string",
        • "check_label_value": "string"
        }
      }
    }
}
Response samples
application/json
{
  • "quote_reference": "string",
  • "payer": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "card_proxy": "string",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "preferred_transfer_type": "string",
      • "account_type": "string",
      • "instrument_type": "string"
      }
    ],
  • "payee": [
    • {
      • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
      • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
      • "card_proxy": "string",
      • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
      • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
      • "preferred_transfer_type": "string",
      • "account_type": "string",
      • "instrument_type": "string"
      }
    ],
  • "payment_amount": 0,
  • "payment_base_currency": "string",
  • "payment_description": "string",
  • "payment_request_code": "PT_TOPUP",
  • "payment_balance": 0,
  • "payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259",
  • "payment_chain": "19e771ce-e346-4119-b133-6e58f85f159f",
  • "response_code": "string",
  • "reason_code": "string",
  • "requestor_wallet_guid": "996c589d-2ec1-4921-a37b-692f64c4cb1c",
  • "payment_due_date": "2019-08-24T14:15:22Z",
  • "reference_code": "string",
  • "payment_schedule": {
    • "payment_schedule_type": "IMMEDIATE",
    • "frequency": "DAY",
    • "period_value": 0,
    • "repeat_until_date": "2019-08-24T14:15:22Z",
    • "payment_start_date": "2019-08-24T14:15:22Z",
    • "schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c"
    },
  • "foreign_exchange_purpose_code": "EFT_TRF_SELF",
  • "additional_data": {
    • "check_info": {
      • "template_alias": "string",
      • "payee_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "ship_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "shipping_method": "string",
      • "bulk_shipment_flag": true,
      • "return_to_detail": {
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "remittance_section_1": {
        • "remittance_s1_line1": "string",
        • "remittance_s1_line2": "string",
        • "remittance_s1_line3": "string",
        • "remittance_s1_line4": "string",
        • "remittance_s1_line5": "string",
        • "remittance_s1_line6": "string"
        },
      • "remittance_section_2": {
        • "remittance_s2_line1": "string",
        • "remittance_s2_line2": "string",
        • "remittance_s2_line3": "string"
        },
      • "check_stub_footer_text": "string",
      • "payer_detail": {
        • "payer_logo_file_name": "string",
        • "name": "string",
        • "address_line1": "string",
        • "address_line2": "string",
        • "city": "string",
        • "state": "string",
        • "zip": "string",
        • "country": "string"
        },
      • "check_void_after_days": 1,
      • "check_memo_line": "string",
      • "check_footer_text": "string",
      • "print_authorized_signatory1": true,
      • "print_authorized_signatory2": true,
      • "additional_detail": {
        • "check_stub_label1": "string",
        • "check_stub_label1_value": "string",
        • "check_stub_label2": "string",
        • "check_stub_label2_value": "string",
        • "check_label": "string",
        • "check_label_value": "string"
        }
      }
    },
  • "error_code": "string",
  • "error_description": "string"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.