COPAYM Contributions for payment (D09B)

This is the standard EDIFACT D09B spec, with 7 loops and 46 segment positions. Its structure is below. Download it as OpenEDI JSON, an ediFabric C# template or an ediFabric Native model, or customize it for a trading partner in the EDI Spec Builder.

Download the COPAYM spec

Sign in to download, free with the Community plan. Every plan includes 50 spec downloads a day, of any shape, after you accept the spec licence once. The C# template comes with the common segments, composites and codes it needs.

Customize in Spec Builder

Use the COPAYM spec in your code

ediFabric .NET

Add the C# template and its common files to your project, or reference the template NuGet package, and read COPAYM files into TSCOPAYM objects. See ediFabric .NET.

ediFabric Native

Native supports X12 today, and EDIFACT is coming. When it's available, map version D09B to this Native model with set_map to parse COPAYM files to JSON from Python, Java, C or C#. See ediFabric Native.

OpenEDI

Select Customize in Spec Builder to copy the spec under your own name, change it for your partner, and parse files against it in EdiNation, ediFabric Native or ediFabric Cloud. Read about OpenEDI.

Generate COPAYM classes in Python, Java, Node.js, Go, Rust or C

The OpenEDI file describes each COPAYM as JSON. To work with COPAYM data as typed objects, generate classes from the OpenEDI file in your language; the root class is TSCOPAYM. The classes keep the loops, segments, lengths and code lists, but not the EDI data formats. Read more in Generate a class from OpenEDI.

Python: datamodel-code-generator. Node.js: openapi-typescript. Java, Go, Rust and C: OpenAPI Generator.

COPAYM structure

Loops and segments of the standard COPAYM, with their usage and maximum repeats.

IDNameUsageMax use
UNHMessage HeaderOptional1
BGMBEGINNING OF MESSAGEMandatory1
GEIPROCESSING INFORMATIONMandatory1
DTMDATE/TIME/PERIODMandatory9
QTYQUANTITYOptional1
RFFREFERENCEOptional9
CUXCURRENCIESOptional1
Loop PNAPARTY IDENTIFICATIONMandatory9
PNAPARTY IDENTIFICATIONMandatory1
ADRADDRESSOptional1
CTACONTACT INFORMATIONOptional1
COMCOMMUNICATION CONTACTOptional9
RFFREFERENCEOptional9
ATTATTRIBUTEOptional9
UNSSECTION CONTROLMandatory1
Loop PNAPARTY IDENTIFICATIONMandatory9999
PNAPARTY IDENTIFICATIONMandatory1
ADRADDRESSOptional9
CTACONTACT INFORMATIONOptional1
COMCOMMUNICATION CONTACTOptional9
DTMDATE/TIME/PERIODOptional9
MOAMONETARY AMOUNTOptional9
QTYQUANTITYOptional99
RFFREFERENCEOptional9
ATTATTRIBUTEOptional9
Loop COTCONTRIBUTION DETAILSOptional999
COTCONTRIBUTION DETAILSMandatory1
DLIDOCUMENT LINE IDENTIFICATIONOptional1
DTMDATE/TIME/PERIODOptional1
PCDPERCENTAGE DETAILSOptional9
MOAMONETARY AMOUNTOptional9
QTYQUANTITYOptional9
RFFREFERENCEOptional9
ATTATTRIBUTEOptional9
Loop LOCPLACE/LOCATION IDENTIFICATIONOptional99
LOCPLACE/LOCATION IDENTIFICATIONMandatory1
Loop PCDPERCENTAGE DETAILSMandatory9
PCDPERCENTAGE DETAILSMandatory1
MOAMONETARY AMOUNTMandatory9
UNSUNS2Mandatory1
MOAMONETARY AMOUNTOptional9
CNTCONTROL TOTALOptional1
Loop PAIPAYMENT INSTRUCTIONSOptional9
PAIPAYMENT INSTRUCTIONSMandatory1
FIIFINANCIAL INSTITUTION INFORMATIONOptional1
MOAMONETARY AMOUNTOptional9
RFFREFERENCEOptional9
DTMDATE/TIME/PERIODOptional9
Loop AUTAUTHENTICATION RESULTOptional9
AUTAUTHENTICATION RESULTMandatory1
DTMDATE/TIME/PERIODOptional9
RFFREFERENCEOptional9
UNTMessage TrailerOptional1